home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / network / mail / stmh1_2.lzh / STMH1_2.TXT < prev    next >
Text File  |  1995-01-14  |  18KB  |  400 lines
  1. STMH v1.2b
  2. Beta release 14/1/95
  3. Development by Stephen K Mulrine <robotron@moroder.demon.co.uk>
  4. Additions by Graeme Mullin <grm@inedible.demon.co.uk>
  5. Bug reports and comments to stmh@moroder.demon.co.uk
  6.  
  7. Based (loosely) on the Rand MH Message Handling System.
  8.  
  9. Requirements
  10. ------------
  11. Any Atari ST, TT or Falcon
  12. Hard disk with at least .5MB free
  13. Demon NOS software
  14. Text editor (e.g. Gnome, as supplied with Demon's NOS package)
  15.  
  16. First-time Installation
  17. -----------------------
  18. 1. Print this file!  You won't be able to use STMH without a list of
  19.    commands.
  20. 2. Copy all the .ttp and .bat files into the same directory as the NOS
  21.    software.
  22. 3. Double-click on "demon.tos" and choose option F (at time of writing) for
  23.    "Command Shell".
  24. 4. Enter "stmhinst".  This will create a directory called "stmh", your first
  25.    message folder ("+outgoing"), and a configuration file called "stmh.rc"
  26.    using the settings from your "mailer.rc" file.  (You may then wish to
  27.    examine or edit this file, e.g. "gnome stmh\stmh.rc".)
  28. 5. Enter "inc" to extract messages from your mailbox.
  29.  
  30. Upgrading from v1.1
  31. -------------------
  32. 1. Copy all the .ttp and .bat files into the same directory as the NOS
  33.    software.
  34. 2. Double-click on "demon.tos" and choose option F (at time of writing) for
  35.    "Command Shell".
  36. 3. Edit your configuration file (e.g. "gnome stmh\stmh.rc") and change the
  37.    setting for the "news" variable from "mail2news@news.demon.co.uk" to
  38.    "mail2news@peernews.demon.co.uk".
  39.  
  40. Concepts
  41. --------
  42. STMH uses folders, within which messages are stored.  Folder names are
  43. prefixed by a "+".  Each message within a folder has a number.  Messages can
  44. be moved from folder to folder.  And, because folders are independent of one
  45. another, two messages in different folders can have the same number.
  46.  
  47. There are three "special" folders.  "+inbox" is normally used to hold new
  48. (incoming) messages, "+outgoing" holds all your replies until you send them,
  49. and "+sent" optionally holds a copy of all the messages you send.
  50.  
  51. When you forward or reply to a message, or compose a new one, you create a
  52. new message in the "+outgoing" folder.  You don't have to send it straight
  53. away - you can have several messages in "+outgoing" at a time, and only
  54. send a particular message when you've finished working on it.
  55.  
  56. Just as STMH breaks your mailbox up into separate messages, STMH itself is
  57. broken up into several different programs.  (Most other mailers consist of
  58. one program with all the necessary functions built in.)  The idea behind
  59. this is that you can intersperse mailer commands with other functions, e.g.
  60. edit a program, reply to somebody's mail, compile the program..
  61.  
  62. Programs
  63. --------
  64. stmhinst:      set up STMH according to existing "mailer" configuration
  65. stmh:          list STMH functions (basically shows this list)
  66. inc:           read messages from mailbox into folder
  67. scan:          give one-line summaries of messages in folder
  68. refile:        move a message from one folder to another
  69. rmm:           remove a message
  70. folders:       list existing folders
  71. show:          display a message
  72. next:          display next message
  73. prev:          display previous message
  74. comp:          compose a new message
  75. repl:          reply to a message
  76. forw:          forward a message
  77. pending:       give one-line summaries of messages waiting to be sent
  78. send:          send a message
  79. post:          post a message as a news article
  80. compact:       renumber messages in a folder, starting at 1
  81. whatnow:       simple front end used by comp, repl and forw
  82.  
  83. All the programs, with the exception of stmhinst and stmh, can be run with a
  84. "-help" flag for a full description of command-line arguments without
  85. actually performing that function - "rmm -help" is perfectly safe.
  86.  
  87. Related files
  88. -------------
  89. stmh.rc:       configuration file
  90. signatur:      signature file
  91. aliases:       list of aliases
  92.  
  93. If the STMH environment variable is undefined, STMH looks for all these
  94. files in the directory "$NOS_ROOT\stmh".
  95.  
  96. Environment variables
  97. ---------------------
  98. NOS_ROOT:      NOS base directory; also used by NOS and SNEWS
  99. STMH:          STMH base directory (default is $NOS_ROOT\stmh)
  100. STMHCFG:       configuration file (default is $STMH\stmh.rc)
  101. STMHMBX:       name of mailbox (default is based on user name)
  102. USERNAME:      user name (alternatively USER)
  103. FULLNAME:      full name (alternatively NAME)
  104. ORGANIZATION:  name of organisation (alternatively ORGANISATION)
  105. HOSTNAME:      host name (alternatively HOST)
  106. DOMAINNAME:    domain name (alternatively DOMAIN)
  107. TIMEZONE:      time zone (alternatively TZ).  Default is +0000
  108. EDITOR:        name of editor to use (default is "vi")
  109.  
  110. Configuration file settings (default values shown where appropriate)
  111. --------------------------------------------------------------------
  112. user:          user name
  113. mailbox:       name of mailbox (only needed if different from user name)
  114. name:          full name
  115. host:          host name
  116. domain:        domain name (not needed if host name includes .demon.co.uk)
  117. editor:        name of editor to use (if not set, default to "vi")
  118. org:           name of organisation (only used for news articles)
  119. timezone:      valid RFC-822 time zone (if not set, defaults to +0000)
  120. archive:       save a copy of sent messages in folder "+sent"? (y/N)
  121. us_date:       show "inc", "scan" and "pending" dates in US format? (y/N)
  122. backup:        keep a backup (.bkp) of all deleted/sent messages? (Y/n)
  123. update:        should "inc" make "+inbox" the current folder? (Y/n)
  124. news:          email address of mail-to-news gateway
  125. gateway:       mail gateway for all mail to be relayed through
  126. reply_quote:   quote character to use when replying [>]
  127. forward_quote: quote character to use when forwarding [>]
  128.  
  129. Note that where an environment variable and a configuration file setting
  130. have the same meaning, the environment variable will always take precedence.
  131.  
  132. Examples
  133. --------
  134. inc            reads mail into folder "+inbox"
  135. inc +new       reads mail into folder "+new"
  136. inc root       reads mail into folder "+inbox" from root's mailbox
  137.  
  138. scan           summarises messages in current folder
  139. scan +inbox    summarises messages in folder "+inbox", also makes "+inbox"
  140.                  the current folder
  141.  
  142. refile +jim    moves the current message into folder "+jim"
  143. refile 4 +jim  moves message 4 in the current folder into folder "+jim"
  144. refile +a +b   moves the current message from folder "+a" into folder "+b"
  145.  
  146. rmm            removes the current message
  147. rmm 5          removes message 5 in the current folder
  148. rmm 5 +jim     removes message 5 in folder "+jim"
  149.  
  150. folders        lists existing folders - current folder denoted by "*"
  151.  
  152. show           display current message
  153. show 6         display message 6 in the current folder (and set current
  154.                  message to be 6)
  155. show 6 +jim    display message 6 in folder "+jim"
  156. show -full     display current message with full headers
  157. show -file f1  save current message to file "f1"
  158.  
  159. next           display message after current message (and set current
  160.                  message to be this one)
  161. next +jim      display next message in folder "+jim"
  162.  
  163. prev           display message before current message (and set current
  164.                  message to be this one)
  165. prev +jim      display previous message in folder "+jim"
  166.  
  167. comp           compose a new message
  168. comp 7         edit message 7 in folder "+outgoing"
  169. comp -file x1  compose a new message, incorporating file "x1"
  170.  
  171. repl           reply to current message
  172. repl 8         reply to message 8 in current folder
  173. repl 8 +jim    reply to message 8 in folder "+jim"
  174. repl -full     reply to current message, quoting original headers
  175.  
  176. forw           forward current message
  177. forw 9         forward message 9 in current folder
  178. forw 9 +jim    forward message 9 in folder "+jim"
  179. forw -full     forward current message, quoting original headers
  180.  
  181. pending        summarise messages in "+outgoing" folder
  182. pending -sent  summarise messages in "+sent" folder (if "archive" is set in
  183.